<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Calico: calico/statusor_macros.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Calico
   </div>
   <div id="projectbrief">A visual-inertial calibration library designed for rapid problem construction and debugging.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_e7ac338090e46d594d3ea7a0e9efc7ba.html">calico</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">statusor_macros.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef CALICO_STATUSOR_MACROS_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define CALICO_STATUSOR_MACROS_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;sstream&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;absl/status/status.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;absl/status/statusor.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &quot;calico/status_builder.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;gmock/gmock.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &quot;gtest/gtest.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">// absl matchers pulled/derived from here:</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">// https://github.com/abseil/abseil-cpp/issues/951#issuecomment-828460483</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">inline</span> const ::absl::Status&amp; GetStatus(const ::absl::Status&amp; status) {</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;  <span class="keywordflow">return</span> status;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;}</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">inline</span> const ::absl::Status&amp; GetStatus(const ::absl::StatusOr&lt;T&gt;&amp; status) {</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;  <span class="keywordflow">return</span> status.status();</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;}</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">// Monomorphic implementation of matcher IsOkAndHolds(m).  StatusOrType is a</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">// reference to StatusOr&lt;T&gt;.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> StatusOrType&gt;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classIsOkAndHoldsMatcherImpl.html">   31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classIsOkAndHoldsMatcherImpl.html">IsOkAndHoldsMatcherImpl</a></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    : <span class="keyword">public</span> ::testing::MatcherInterface&lt;StatusOrType&gt; {</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  <span class="keyword">typedef</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;      <span class="keyword">typename</span> std::remove_reference&lt;StatusOrType&gt;::type::value_type value_type;</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">typename</span> InnerMatcher&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classIsOkAndHoldsMatcherImpl.html">IsOkAndHoldsMatcherImpl</a>(InnerMatcher&amp;&amp; inner_matcher)</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;      : inner_matcher_(::testing::SafeMatcherCast&lt;const value_type&amp;&gt;(</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;            std::forward&lt;InnerMatcher&gt;(inner_matcher))) {}</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <span class="keywordtype">void</span> DescribeTo(std::ostream* os)<span class="keyword"> const override </span>{</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    *os &lt;&lt; <span class="stringliteral">&quot;is OK and has a value that &quot;</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    inner_matcher_.DescribeTo(os);</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  }</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <span class="keywordtype">void</span> DescribeNegationTo(std::ostream* os)<span class="keyword"> const override </span>{</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    *os &lt;&lt; <span class="stringliteral">&quot;isn&#39;t OK or has a value that &quot;</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    inner_matcher_.DescribeNegationTo(os);</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  }</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="keywordtype">bool</span> MatchAndExplain(</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;      StatusOrType actual_value,</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;      ::testing::MatchResultListener* result_listener)<span class="keyword"> const override </span>{</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keywordflow">if</span> (!actual_value.ok()) {</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;      *result_listener &lt;&lt; <span class="stringliteral">&quot;which has status &quot;</span> &lt;&lt; actual_value.status();</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;      <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    }</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    ::testing::StringMatchResultListener inner_listener;</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keyword">const</span> <span class="keywordtype">bool</span> matches =</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        inner_matcher_.MatchAndExplain(*actual_value, &amp;inner_listener);</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keyword">const</span> std::string inner_explanation = inner_listener.str();</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordflow">if</span> (!inner_explanation.empty()) {</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;      *result_listener &lt;&lt; <span class="stringliteral">&quot;which contains value &quot;</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;                       &lt;&lt; ::testing::PrintToString(*actual_value) &lt;&lt; <span class="stringliteral">&quot;, &quot;</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                       &lt;&lt; inner_explanation;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    }</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keywordflow">return</span> matches;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  }</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  const ::testing::Matcher&lt;const value_type&amp;&gt; inner_matcher_;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;};</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">// Implements IsOkAndHolds(m) as a polymorphic matcher.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> InnerMatcher&gt;</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classIsOkAndHoldsMatcher.html">   78</a></span>&#160;<span class="keyword">class </span><a class="code" href="classIsOkAndHoldsMatcher.html">IsOkAndHoldsMatcher</a> {</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classIsOkAndHoldsMatcher.html">IsOkAndHoldsMatcher</a>(InnerMatcher inner_matcher)</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;      : inner_matcher_(std::move(inner_matcher)) {}</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  <span class="comment">// Converts this polymorphic matcher to a monomorphic matcher of the</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="comment">// given type.  StatusOrType can be either StatusOr&lt;T&gt; or a</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <span class="comment">// reference to StatusOr&lt;T&gt;.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">typename</span> StatusOrType&gt;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;  operator ::testing::Matcher&lt;StatusOrType&gt;()<span class="keyword"> const </span>{  <span class="comment">// NOLINT</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    return ::testing::Matcher&lt;StatusOrType&gt;(</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        <span class="keyword">new</span> <a class="code" href="classIsOkAndHoldsMatcherImpl.html">IsOkAndHoldsMatcherImpl&lt;const StatusOrType&amp;&gt;</a>(inner_matcher_));</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;  }</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  <span class="keyword">const</span> InnerMatcher inner_matcher_;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;};</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">// Monomorphic implementation of matcher IsOk() for a given type T.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment">// T can be Status, StatusOr&lt;&gt;, or a reference to either of them.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classMonoIsOkMatcherImpl.html">   99</a></span>&#160;<span class="keyword">class </span><a class="code" href="classMonoIsOkMatcherImpl.html">MonoIsOkMatcherImpl</a> : <span class="keyword">public</span> ::testing::MatcherInterface&lt;T&gt; {</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  <span class="keywordtype">void</span> DescribeTo(std::ostream* os)<span class="keyword"> const override </span>{ *os &lt;&lt; <span class="stringliteral">&quot;is OK&quot;</span>; }</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  <span class="keywordtype">void</span> DescribeNegationTo(std::ostream* os)<span class="keyword"> const override </span>{</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    *os &lt;&lt; <span class="stringliteral">&quot;is not OK&quot;</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  }</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  <span class="keywordtype">bool</span> MatchAndExplain(T actual_value,</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;                       ::testing::MatchResultListener*)<span class="keyword"> const override </span>{</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="keywordflow">return</span> GetStatus(actual_value).ok();</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  }</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;};</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">// Implements IsOk() as a polymorphic matcher.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classIsOkMatcher.html">  112</a></span>&#160;<span class="keyword">class </span><a class="code" href="classIsOkMatcher.html">IsOkMatcher</a> {</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  operator ::testing::Matcher&lt;T&gt;()<span class="keyword"> const </span>{  <span class="comment">// NOLINT</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    return ::testing::Matcher&lt;T&gt;(<span class="keyword">new</span> <a class="code" href="classMonoIsOkMatcherImpl.html">MonoIsOkMatcherImpl&lt;T&gt;</a>());</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  }</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;};</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">// Returns a gMock matcher that matches a StatusOr&lt;&gt; whose status is</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">// OK and whose value matches the inner matcher.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> InnerMatcher&gt;</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<a class="code" href="classIsOkAndHoldsMatcher.html">IsOkAndHoldsMatcher&lt;typename std::decay&lt;InnerMatcher&gt;::type</a>&gt; IsOkAndHolds(</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    InnerMatcher&amp;&amp; inner_matcher) {</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="classIsOkAndHoldsMatcher.html">IsOkAndHoldsMatcher&lt;typename std::decay&lt;InnerMatcher&gt;::type</a>&gt;(</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;      std::forward&lt;InnerMatcher&gt;(inner_matcher));</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;}</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160; </div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">// Returns a gMock matcher that matches a Status or StatusOr&lt;&gt; which is OK.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="keyword">inline</span> <a class="code" href="classIsOkMatcher.html">IsOkMatcher</a> IsOk() { <span class="keywordflow">return</span> <a class="code" href="classIsOkMatcher.html">IsOkMatcher</a>(); }</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160; </div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">// Macros for testing the results of functions that return absl::Status or</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">// absl::StatusOr&lt;T&gt; (for any type T).</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment">//#define EXPECT_OK(expression) EXPECT_THAT(expression, IsOk())</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160; </div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">// Macros for testing the results of functions that returns absl::Status.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="preprocessor">#define EXPECT_OK(statement) \</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="preprocessor">  EXPECT_EQ(absl::OkStatus(), (statement))</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="preprocessor">#define ASSERT_OK(statement) \</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="preprocessor">  ASSERT_EQ(absl::OkStatus(), (statement))</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160; </div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">// Run a command that returns a absl::Status.  If the called code returns an</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">// error status, return that status up out of this method too.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">// Example:</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">//   RETURN_IF_ERROR(DoThings(4));</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">//   RETURN_IF_ERROR(DoThings(5)) &lt;&lt; &quot;Additional error context&quot;;</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="preprocessor">#define RETURN_IF_ERROR(expr)                                        \</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="preprocessor">  switch (0)                                                         \</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="preprocessor">  case 0:                                                            \</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="preprocessor">  default:                                                           \</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="preprocessor">    if (const ::absl::Status status_macro_internal_adaptor = (expr); \</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="preprocessor">        status_macro_internal_adaptor.ok()) {                        \</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="preprocessor">    } else </span><span class="comment">/* NOLINT */</span><span class="preprocessor">                                              \</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="preprocessor">      return ::util::StatusBuilder(status_macro_internal_adaptor)</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160; </div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">// Executes an expression that returns an absl::StatusOr, extracting its value</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">// into the variable defined by lhs (or returning on error).</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">// Example: Assigning to an existing value</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">//   ValueType value;</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">//   ASSIGN_OR_RETURN(value, MaybeGetValue(arg));</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">//   ASSIGN_OR_RETURN((auto [key, val]), MaybeGetValue(arg));</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment">// WARNING: ASSIGN_OR_RETURN expands into multiple statements; it cannot be used</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment">//  in a single statement (e.g. as the body of an if statement without {})!</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="preprocessor">#define ASSIGN_OR_RETURN(lhs, rexpr)    \</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="preprocessor">  STATUS_MACROS_IMPL_ASSIGN_OR_RETURN_( \</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="preprocessor">      STATUS_MACROS_IMPL_CONCAT_(_status_or_value, __COUNTER__), lhs, rexpr);</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="preprocessor">#define STATUS_MACROS_IMPL_ASSIGN_OR_RETURN_(statusor, lhs, rexpr) \</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="preprocessor">  auto statusor = (rexpr);                                         \</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="preprocessor">  RETURN_IF_ERROR(statusor.status());                              \</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="preprocessor">  STATUS_MACROS_IMPL_UNPARENTHESIS(lhs) = std::move(statusor).value()</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160; </div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment">// Internal helpers for macro expansion.</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="preprocessor">#define STATUS_MACROS_IMPL_UNPARENTHESIS_INNER(...) \</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="preprocessor">  STATUS_MACROS_IMPL_UNPARENTHESIS_INNER_(__VA_ARGS__)</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="preprocessor">#define STATUS_MACROS_IMPL_UNPARENTHESIS_INNER_(...) \</span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="preprocessor">  STATUS_MACROS_IMPL_VAN##__VA_ARGS__</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="preprocessor">#define ISH(...) ISH __VA_ARGS__</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="preprocessor">#define STATUS_MACROS_IMPL_VANISH</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160; </div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment">// If the input is parenthesized, removes the parentheses. Otherwise expands to</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment">// the input unchanged.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="preprocessor">#define STATUS_MACROS_IMPL_UNPARENTHESIS(...) \</span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="preprocessor">  STATUS_MACROS_IMPL_UNPARENTHESIS_INNER(ISH __VA_ARGS__)</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160; </div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">// Internal helper for concatenating macro values.</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="preprocessor">#define STATUS_MACROS_IMPL_CONCAT_INNER_(x, y) x##y</span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="preprocessor">#define STATUS_MACROS_IMPL_CONCAT_(x, y) STATUS_MACROS_IMPL_CONCAT_INNER_(x, y)</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160; </div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="preprocessor">#define CONCAT_IMPL(x, y) x##y</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="preprocessor">#define CONCAT_MACRO(x, y) CONCAT_IMPL(x, y)</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="preprocessor">#define ASSERT_OK_AND_ASSIGN_IMPL(statusor, lhs, rexpr)  \</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="preprocessor">  auto statusor = (rexpr);                               \</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="preprocessor">  ASSERT_TRUE(statusor.status().ok()) &lt;&lt;                 \</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="preprocessor">      statusor.status();                                 \</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="preprocessor">  lhs = std::move(statusor.value())</span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160; </div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="preprocessor">#define ASSERT_OK_AND_ASSIGN(lhs, rexpr)        \</span></div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="preprocessor">  ASSERT_OK_AND_ASSIGN_IMPL(CONCAT_MACRO(       \</span></div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="preprocessor">      _status_or, __COUNTER__), lhs, rexpr)</span></div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160; </div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CALICO_STATUSOR_MACROS_H_</span></div>
<div class="ttc" id="aclassIsOkAndHoldsMatcherImpl_html"><div class="ttname"><a href="classIsOkAndHoldsMatcherImpl.html">IsOkAndHoldsMatcherImpl</a></div><div class="ttdef"><b>Definition:</b> statusor_macros.h:32</div></div>
<div class="ttc" id="aclassIsOkAndHoldsMatcher_html"><div class="ttname"><a href="classIsOkAndHoldsMatcher.html">IsOkAndHoldsMatcher</a></div><div class="ttdef"><b>Definition:</b> statusor_macros.h:78</div></div>
<div class="ttc" id="aclassIsOkMatcher_html"><div class="ttname"><a href="classIsOkMatcher.html">IsOkMatcher</a></div><div class="ttdef"><b>Definition:</b> statusor_macros.h:112</div></div>
<div class="ttc" id="aclassMonoIsOkMatcherImpl_html"><div class="ttname"><a href="classMonoIsOkMatcherImpl.html">MonoIsOkMatcherImpl</a></div><div class="ttdef"><b>Definition:</b> statusor_macros.h:99</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
